
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module fgcp.command</title>
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="fgcp.html"><font color="#ffffff">fgcp</font></a>.command</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="http://code.google.com/p/fgcp-client-api/source/browse/fgcp/command.py">command.py</a></font></td></tr></table>
    <p><tt>API&nbsp;Commands&nbsp;to&nbsp;the&nbsp;Fujitsu&nbsp;Global&nbsp;Cloud&nbsp;Platform&nbsp;(FGCP)<br>
&nbsp;<br>
Example:&nbsp;[see&nbsp;tests/test_api.py&nbsp;for&nbsp;more&nbsp;examples]<br>
&nbsp;<br>
#&nbsp;Connect&nbsp;with&nbsp;your&nbsp;client&nbsp;certificate&nbsp;to&nbsp;region&nbsp;'uk'<br>
from&nbsp;fgcp.command&nbsp;import&nbsp;<a href="#FGCPCommand">FGCPCommand</a><br>
api_proxy&nbsp;=&nbsp;<a href="#FGCPCommand">FGCPCommand</a>('client.pem',&nbsp;'uk')<br>
&nbsp;<br>
#&nbsp;Call&nbsp;standard&nbsp;API&nbsp;commands&nbsp;with&nbsp;identifiers<br>
vsystems&nbsp;=&nbsp;api_proxy.ListVSYS()<br>
for&nbsp;vsys&nbsp;in&nbsp;vsystems:<br>
&nbsp;&nbsp;&nbsp;&nbsp;status&nbsp;=&nbsp;api_proxy.GetVSYSStatus(vsys.vsysId)<br>
&nbsp;&nbsp;&nbsp;&nbsp;vsysconfig&nbsp;=&nbsp;api_proxy.GetVSYSConfiguration(vsys.vsysId)<br>
&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;vserver&nbsp;in&nbsp;vsysconfig.vservers:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;status&nbsp;=&nbsp;api_proxy.GetVServerStatus(vsys.vsysId,&nbsp;vserver.vserverId)<br>
&nbsp;&nbsp;&nbsp;&nbsp;...</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="fgcp.html#FGCPError">fgcp.FGCPError</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.command.html#FGCPCommandError">FGCPCommandError</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.command.html#FGCPGetEFMConfigHandler">FGCPGetEFMConfigHandler</a>
</font></dt><dt><font face="helvetica, arial"><a href="fgcp.command.html#FGCPUpdateEFMConfigHandler">FGCPUpdateEFMConfigHandler</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a>(<a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.command.html#FGCPCommand">FGCPCommand</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPCommand">class <strong>FGCPCommand</strong></a>(<a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Proxy&nbsp;for&nbsp;FGCP&nbsp;API&nbsp;Commands<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.command.html#FGCPCommand">FGCPCommand</a></dd>
<dd><a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a></dd>
<dd><a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FGCPCommand-AddAddressRange"><strong>AddAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPCommand-AllocatePublicIP"><strong>AllocatePublicIP</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPCommand-AttachPublicIP"><strong>AttachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPCommand-AttachVDisk"><strong>AttachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPCommand-BackupEFM"><strong>BackupEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPCommand-BackupVDisk"><strong>BackupVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPCommand-CreateAddressPool"><strong>CreateAddressPool</strong></a>(self, pipFrom<font color="#909090">=None</font>, pipTo<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPCommand-CreateEFM"><strong>CreateEFM</strong></a>(self, vsysId, efmType, efmName, networkId)</dt><dd><tt>Usage:&nbsp;efmId&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-CreateEFM">CreateEFM</a>(self,&nbsp;vsys.vsysId,&nbsp;'SLB',&nbsp;'My&nbsp;LoadBalancer',&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPCommand-CreateVDisk"><strong>CreateVDisk</strong></a>(self, vsysId, vdiskName, size)</dt><dd><tt>Usage:&nbsp;vdiskId&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-CreateVDisk">CreateVDisk</a>(self,&nbsp;vsys.vsysId,&nbsp;vdiskName,&nbsp;size)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-CreateVSYS"><strong>CreateVSYS</strong></a>(self, vsysDescriptorId, vsysName)</dt><dd><tt>Usage:&nbsp;vsysId&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-CreateVSYS">CreateVSYS</a>(vsysdescriptor.vsysdescriptorId,&nbsp;'My&nbsp;New&nbsp;System')</tt></dd></dl>

<dl><dt><a name="FGCPCommand-CreateVServer"><strong>CreateVServer</strong></a>(self, vsysId, vserverName, vserverType, diskImageId, networkId)</dt><dd><tt>Usage:&nbsp;vserverId&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-CreateVServer">CreateVServer</a>(self,&nbsp;vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Server',&nbsp;servertype.name,&nbsp;diskimage.diskimageId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPCommand-DeleteAddressRange"><strong>DeleteAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPCommand-DestroyEFM"><strong>DestroyEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPCommand-DestroyEFMBackup"><strong>DestroyEFMBackup</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPCommand-DestroyVDisk"><strong>DestroyVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPCommand-DestroyVDiskBackup"><strong>DestroyVDiskBackup</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPCommand-DestroyVSYS"><strong>DestroyVSYS</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPCommand-DestroyVServer"><strong>DestroyVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPCommand-DetachPublicIP"><strong>DetachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPCommand-DetachVDisk"><strong>DetachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPCommand-FreePublicIP"><strong>FreePublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPCommand-GetAddressRange"><strong>GetAddressRange</strong></a>(self)</dt><dd><tt>Usage:&nbsp;addressranges&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetAddressRange">GetAddressRange</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetDiskImageAttributes"><strong>GetDiskImageAttributes</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;diskimage&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetDiskImageAttributes">GetDiskImageAttributes</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetEFMAttributes"><strong>GetEFMAttributes</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;efmattr&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetEFMAttributes">GetEFMAttributes</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetEFMConfigHandler"><strong>GetEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;GetEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;<a href="#FGCPGetEFMConfigHandler">FGCPGetEFMConfigHandler</a>&nbsp;for&nbsp;details<br>
Usage:&nbsp;fw_policies&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetEFMConfigHandler">GetEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_policy(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetEFMConfiguration"><strong>GetEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;GetEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetEFMStatus"><strong>GetEFMStatus</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetEFMStatus">GetEFMStatus</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetEventLog"><strong>GetEventLog</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;logs&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetEventLog">GetEventLog</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetInformation"><strong>GetInformation</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;infos&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetInformation">GetInformation</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetPerformanceInformation"><strong>GetPerformanceInformation</strong></a>(self, vsysId, vserverId, interval<font color="#909090">='10minute'</font>, dataType<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;perfinfos&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetPerformanceInformation">GetPerformanceInformation</a>(vsys.vsysId,&nbsp;vserver.vserverId,&nbsp;interval='hour')</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetPublicIPAttributes"><strong>GetPublicIPAttributes</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;publicipattr&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetPublicIPAttributes">GetPublicIPAttributes</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetPublicIPStatus"><strong>GetPublicIPStatus</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetPublicIPStatus">GetPublicIPStatus</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetSystemUsage"><strong>GetSystemUsage</strong></a>(self, vsysIds<font color="#909090">=None</font>)</dt><dd><tt>NOTE:&nbsp;extra&nbsp;'date'&nbsp;element&nbsp;on&nbsp;top-level&nbsp;compared&nbsp;to&nbsp;other&nbsp;API&nbsp;calls&nbsp;!<br>
Usage:&nbsp;date,&nbsp;usage&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetSystemUsage">GetSystemUsage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVDiskAttributes"><strong>GetVDiskAttributes</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;vdiskattr&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVDiskAttributes">GetVDiskAttributes</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVDiskStatus"><strong>GetVDiskStatus</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVDiskStatus">GetVDiskStatus</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVSYSAttributes"><strong>GetVSYSAttributes</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysattr&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVSYSAttributes">GetVSYSAttributes</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVSYSConfiguration"><strong>GetVSYSConfiguration</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysconfig&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVSYSConfiguration">GetVSYSConfiguration</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVSYSDescriptorAttributes"><strong>GetVSYSDescriptorAttributes</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorattr&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVSYSDescriptorAttributes">GetVSYSDescriptorAttributes</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVSYSDescriptorConfiguration"><strong>GetVSYSDescriptorConfiguration</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorconfig&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVSYSDescriptorConfiguration">GetVSYSDescriptorConfiguration</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVSYSStatus"><strong>GetVSYSStatus</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVSYSStatus">GetVSYSStatus</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVServerAttributes"><strong>GetVServerAttributes</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverattr&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVServerAttributes">GetVServerAttributes</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVServerConfiguration"><strong>GetVServerConfiguration</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverconfig&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVServerConfiguration">GetVServerConfiguration</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVServerInitialPassword"><strong>GetVServerInitialPassword</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;initialpwd&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVServerInitialPassword">GetVServerInitialPassword</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-GetVServerStatus"><strong>GetVServerStatus</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-GetVServerStatus">GetVServerStatus</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListDiskImage"><strong>ListDiskImage</strong></a>(self, serverCategory<font color="#909090">=None</font>, vsysDescriptorId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;diskimages&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListDiskImage">ListDiskImage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListEFM"><strong>ListEFM</strong></a>(self, vsysId, efmType)</dt><dd><tt>Usage:<br>
firewalls&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"FW")<br>
loadbalancers&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"SLB")</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListEFMBackup"><strong>ListEFMBackup</strong></a>(self, vsysId, efmId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListEFMBackup">ListEFMBackup</a>(vsys.vsysId,&nbsp;firewall.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListPublicIP"><strong>ListPublicIP</strong></a>(self, vsysId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;publicips&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListPublicIP">ListPublicIP</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListServerType"><strong>ListServerType</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;servertypes&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListServerType">ListServerType</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListVDisk"><strong>ListVDisk</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vdisks&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListVDisk">ListVDisk</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListVDiskBackup"><strong>ListVDiskBackup</strong></a>(self, vsysId, vdiskId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListVDiskBackup">ListVDiskBackup</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListVSYS"><strong>ListVSYS</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsystems&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListVSYS">ListVSYS</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListVSYSDescriptor"><strong>ListVSYSDescriptor</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsysdescriptors&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListVSYSDescriptor">ListVSYSDescriptor</a>()</tt></dd></dl>

<dl><dt><a name="FGCPCommand-ListVServer"><strong>ListVServer</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vservers&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-ListVServer">ListVServer</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-RegisterPrivateDiskImage"><strong>RegisterPrivateDiskImage</strong></a>(self, vserverId, name, description)</dt></dl>

<dl><dt><a name="FGCPCommand-RegisterPrivateVSYSDescriptor"><strong>RegisterPrivateVSYSDescriptor</strong></a>(self, vsysId, name, description, keyword, vservers)</dt><dd><tt>Usage:<br>
vsys&nbsp;=&nbsp;proxy.GetSystemInventory('My&nbsp;Existing&nbsp;VSYS')<br>
proxy.<a href="#FGCPCommand-RegisterPrivateVSYSDescriptor">RegisterPrivateVSYSDescriptor</a>(vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Template',&nbsp;'This&nbsp;is&nbsp;a&nbsp;new&nbsp;template&nbsp;based&nbsp;on&nbsp;my&nbsp;existing&nbsp;VSYS',&nbsp;'some&nbsp;key&nbsp;words',&nbsp;vsys.vservers)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-RestoreEFM"><strong>RestoreEFM</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPCommand-RestoreVDisk"><strong>RestoreVDisk</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPCommand-StandByConsole"><strong>StandByConsole</strong></a>(self, vsysId, networkId)</dt><dd><tt>Usage:&nbsp;url&nbsp;=&nbsp;proxy.<a href="#FGCPCommand-StandByConsole">StandByConsole</a>(vsys.vsysId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPCommand-StartEFM"><strong>StartEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPCommand-StartVServer"><strong>StartVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPCommand-StopEFM"><strong>StopEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPCommand-StopVServer"><strong>StopVServer</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPCommand-UnregisterDiskImage"><strong>UnregisterDiskImage</strong></a>(self, diskImageId)</dt></dl>

<dl><dt><a name="FGCPCommand-UnregisterPrivateVSYSDescriptor"><strong>UnregisterPrivateVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPCommand-UnregisterVSYSDescriptor"><strong>UnregisterVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateDiskImageAttribute"><strong>UpdateDiskImageAttribute</strong></a>(self, diskImageId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateEFMAttribute"><strong>UpdateEFMAttribute</strong></a>(self, vsysId, efmId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateEFMConfigHandler"><strong>UpdateEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;UpdateEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;<a href="#FGCPUpdateEFMConfigHandler">FGCPUpdateEFMConfigHandler</a>&nbsp;for&nbsp;details<br>
Usage:&nbsp;proxy.<a href="#FGCPCommand-UpdateEFMConfigHandler">UpdateEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_dns('AUTO')</tt></dd></dl>

<dl><dt><a name="FGCPCommand-UpdateEFMConfiguration"><strong>UpdateEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>, filePath<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;UpdateEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPCommand-UpdateVDiskAttribute"><strong>UpdateVDiskAttribute</strong></a>(self, vsysId, vdiskId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateVSYSAttribute"><strong>UpdateVSYSAttribute</strong></a>(self, vsysId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateVSYSConfiguration"><strong>UpdateVSYSConfiguration</strong></a>(self, vsysId, configurationName, configurationValue)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateVSYSDescriptorAttribute"><strong>UpdateVSYSDescriptorAttribute</strong></a>(self, vsysDescriptorId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPCommand-UpdateVServerAttribute"><strong>UpdateVServerAttribute</strong></a>(self, vsysId, vserverId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPCommand-set_verbose"><strong>set_verbose</strong></a>(self, verbose<font color="#909090">=None</font>)</dt><dd><tt>Show&nbsp;output&nbsp;(1),&nbsp;status&nbsp;checks&nbsp;(2)&nbsp;or&nbsp;nothing&nbsp;(0)</tt></dd></dl>

<dl><dt><a name="FGCPCommand-show_output"><strong>show_output</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="FGCPCommand-show_status"><strong>show_status</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><a name="FGCPCommand-__init__"><strong>__init__</strong></a>(self, key_file<font color="#909090">='client.pem'</font>, region<font color="#909090">='de'</font>, verbose<font color="#909090">=0</font>, debug<font color="#909090">=0</font>, conn<font color="#909090">=None</font>)</dt><dd><tt>Use&nbsp;the&nbsp;same&nbsp;PEM&nbsp;file&nbsp;for&nbsp;SSL&nbsp;client&nbsp;certificate&nbsp;and&nbsp;RSA&nbsp;key&nbsp;signature<br>
&nbsp;<br>
Note:&nbsp;to&nbsp;convert&nbsp;your&nbsp;.p12&nbsp;or&nbsp;.pfx&nbsp;file&nbsp;to&nbsp;unencrypted&nbsp;PEM&nbsp;format,&nbsp;you&nbsp;can&nbsp;use<br>
the&nbsp;following&nbsp;'openssl'&nbsp;command:<br>
&nbsp;<br>
openssl&nbsp;pkcs12&nbsp;-in&nbsp;UserCert.p12&nbsp;-out&nbsp;client.pem&nbsp;-nodes</tt></dd></dl>

<dl><dt><a name="FGCPCommand-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPCommand-add_param"><strong>add_param</strong></a>(self, key<font color="#909090">=None</font>, value<font color="#909090">=None</font>, depth<font color="#909090">=0</font>)</dt></dl>

<dl><dt><a name="FGCPCommand-close"><strong>close</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPCommand-connect"><strong>connect</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPCommand-do_action"><strong>do_action</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt><dd><tt>Send&nbsp;the&nbsp;XML-RPC&nbsp;request&nbsp;and&nbsp;get&nbsp;the&nbsp;response</tt></dd></dl>

<dl><dt><a name="FGCPCommand-get_accesskeyid"><strong>get_accesskeyid</strong></a>(self)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPCommand-get_body"><strong>get_body</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPCommand-get_headers"><strong>get_headers</strong></a>(self, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPCommand-get_signature"><strong>get_signature</strong></a>(self, acc<font color="#909090">=None</font>)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPCommand-receive"><strong>receive</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPCommand-send"><strong>send</strong></a>(self, method, uri, body, headers)</dt></dl>

<dl><dt><a name="FGCPCommand-set_conn"><strong>set_conn</strong></a>(self, conn)</dt></dl>

<dl><dt><a name="FGCPCommand-set_key"><strong>set_key</strong></a>(self, key_string)</dt></dl>

<dl><dt><a name="FGCPCommand-set_region"><strong>set_region</strong></a>(self, region)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><strong>api_version</strong> = '2012-02-18'</dl>

<dl><dt><strong>debug</strong> = 0</dl>

<dl><dt><strong>key_file</strong> = 'client.pem'</dl>

<dl><dt><strong>locale</strong> = 'en'</dl>

<dl><dt><strong>region</strong> = 'de'</dl>

<dl><dt><strong>timezone</strong> = 'Central European Time'</dl>

<dl><dt><strong>uri</strong> = '/ovissapi/endpoint'</dl>

<dl><dt><strong>user_agent</strong> = 'OViSS-API-CLIENT'</dl>

<dl><dt><strong>verbose</strong> = 0</dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPCommandError">class <strong>FGCPCommandError</strong></a>(<a href="fgcp.html#FGCPError">fgcp.FGCPError</a>)</font></td></tr>
    
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.command.html#FGCPCommandError">FGCPCommandError</a></dd>
<dd><a href="fgcp.html#FGCPError">fgcp.FGCPError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="fgcp.html#FGCPError">fgcp.FGCPError</a>:<br>
<dl><dt><a name="FGCPCommandError-__init__"><strong>__init__</strong></a>(self, status, message)</dt></dl>

<dl><dt><a name="FGCPCommandError-__str__"><strong>__str__</strong></a>(self)</dt></dl>

<hr>
Data descriptors inherited from <a href="fgcp.html#FGCPError">fgcp.FGCPError</a>:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#FGCPCommandError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>

<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="FGCPCommandError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPCommandError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="FGCPCommandError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPCommandError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="FGCPCommandError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPCommandError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>

<dl><dt><a name="FGCPCommandError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPCommandError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
&nbsp;<br>
Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>

<dl><dt><a name="FGCPCommandError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>

<dl><dt><a name="FGCPCommandError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPCommandError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>

<dl><dt><a name="FGCPCommandError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPCommandError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>

<dl><dt><a name="FGCPCommandError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>

<dl><dt><a name="FGCPCommandError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>

<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPGenericEFMHandler">class <strong>FGCPGenericEFMHandler</strong></a></font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Generic&nbsp;Handler&nbsp;for&nbsp;FGCP&nbsp;Get/Update&nbsp;EFM&nbsp;Configuration&nbsp;methods<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="FGCPGenericEFMHandler-__init__"><strong>__init__</strong></a>(self, proxy, vsysId<font color="#909090">=None</font>, efmId<font color="#909090">=None</font>)</dt></dl>

<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>efmId</strong> = None</dl>

<dl><dt><strong>vsysId</strong> = None</dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPGetEFMConfigHandler">class <strong>FGCPGetEFMConfigHandler</strong></a>(<a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Handler&nbsp;for&nbsp;FGCP&nbsp;GetEFMConfiguration&nbsp;methods<br>
&nbsp;<br>
Example:&nbsp;fw_nat_rules&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_nat_rule">fw_nat_rule</a>()<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="FGCPGetEFMConfigHandler-efm_update"><strong>efm_update</strong></a>(self)</dt><dd><tt>Common&nbsp;method&nbsp;for&nbsp;FW&nbsp;and&nbsp;SLB&nbsp;EFM_UPDATE&nbsp;returns&nbsp;firewall&nbsp;or&nbsp;loadbalancer</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-fw_dns"><strong>fw_dns</strong></a>(self)</dt><dd><tt>Usage:&nbsp;fw_dns&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_dns">fw_dns</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-fw_limit_policy"><strong>fw_limit_policy</strong></a>(self, from_zone<font color="#909090">=None</font>, to_zone<font color="#909090">=None</font>)</dt><dd><tt>CHECKME:&nbsp;for&nbsp;network&nbsp;identifiers&nbsp;besides&nbsp;INTERNET&nbsp;and&nbsp;INTRANET,&nbsp;see&nbsp;GetVSYSConfiguration()<br>
Usage:&nbsp;fw_limit_policy&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_limit_policy">fw_limit_policy</a>(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-fw_log"><strong>fw_log</strong></a>(self, num<font color="#909090">=100</font>, orders<font color="#909090">=None</font>)</dt><dd><tt>CHECKME:&nbsp;for&nbsp;network&nbsp;identifiers&nbsp;besides&nbsp;INTERNET&nbsp;and&nbsp;INTRANET,&nbsp;see&nbsp;GetVSYSConfiguration()<br>
Usage:<br>
ipaddress&nbsp;=&nbsp;vsys.publicips[0].address<br>
orders&nbsp;=&nbsp;[FGCPFWLogOrder(prefix='dst',&nbsp;value=ipaddress,&nbsp;from_zone=None,&nbsp;to_zone=None)]<br>
fw_log&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_log">fw_log</a>(100,&nbsp;orders)</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-fw_nat_rule"><strong>fw_nat_rule</strong></a>(self)</dt><dd><tt>Usage:&nbsp;fw_nat_rules&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_nat_rule">fw_nat_rule</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-fw_policy"><strong>fw_policy</strong></a>(self, from_zone<font color="#909090">=None</font>, to_zone<font color="#909090">=None</font>)</dt><dd><tt>CHECKME:&nbsp;for&nbsp;network&nbsp;identifiers&nbsp;besides&nbsp;INTERNET&nbsp;and&nbsp;INTRANET,&nbsp;see&nbsp;GetVSYSConfiguration()<br>
Usage:&nbsp;fw_policies&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_policy">fw_policy</a>(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-fw_update"><strong>fw_update</strong></a>(self)</dt><dd><tt>Usage:&nbsp;fw_update&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPGetEFMConfigHandler-fw_update">fw_update</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-slb_cert_list"><strong>slb_cert_list</strong></a>(self, certCategory<font color="#909090">=None</font>, detail<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;slb_cert_list&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPGetEFMConfigHandler-slb_cert_list">slb_cert_list</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-slb_error"><strong>slb_error</strong></a>(self)</dt><dd><tt>Usage:&nbsp;slb_error_stats&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPGetEFMConfigHandler-slb_error">slb_error</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-slb_load"><strong>slb_load</strong></a>(self)</dt><dd><tt>Usage:&nbsp;slb_load_stats&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPGetEFMConfigHandler-slb_load">slb_load</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-slb_rule"><strong>slb_rule</strong></a>(self)</dt><dd><tt>Usage:&nbsp;slb_rule&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPGetEFMConfigHandler-slb_rule">slb_rule</a>()</tt></dd></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-slb_try_getaction"><strong>slb_try_getaction</strong></a>(self, action)</dt></dl>

<dl><dt><a name="FGCPGetEFMConfigHandler-slb_update"><strong>slb_update</strong></a>(self)</dt><dd><tt>Usage:&nbsp;slb_update&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPGetEFMConfigHandler-slb_update">slb_update</a>()</tt></dd></dl>

<hr>
Methods inherited from <a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>:<br>
<dl><dt><a name="FGCPGetEFMConfigHandler-__init__"><strong>__init__</strong></a>(self, proxy, vsysId<font color="#909090">=None</font>, efmId<font color="#909090">=None</font>)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>:<br>
<dl><dt><strong>efmId</strong> = None</dl>

<dl><dt><strong>vsysId</strong> = None</dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPUpdateEFMConfigHandler">class <strong>FGCPUpdateEFMConfigHandler</strong></a>(<a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Handler&nbsp;for&nbsp;FGCP&nbsp;UpdateEFMConfiguration&nbsp;methods<br>
&nbsp;<br>
Example:&nbsp;proxy.UpdateEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPUpdateEFMConfigHandler-fw_dns">fw_dns</a>('AUTO')<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="FGCPUpdateEFMConfigHandler-efm_backout"><strong>efm_backout</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-efm_update"><strong>efm_update</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-fw_dns"><strong>fw_dns</strong></a>(self, dnstype<font color="#909090">='AUTO'</font>, primary<font color="#909090">=None</font>, secondary<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;proxy.UpdateEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPUpdateEFMConfigHandler-fw_dns">fw_dns</a>('AUTO')</tt></dd></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-fw_nat_rule"><strong>fw_nat_rule</strong></a>(self, rules<font color="#909090">=None</font>)</dt><dd><tt>Usage:<br>
fw_nat_rules&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPUpdateEFMConfigHandler-fw_nat_rule">fw_nat_rule</a>()<br>
proxy.UpdateEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPUpdateEFMConfigHandler-fw_nat_rule">fw_nat_rule</a>(fw_nat_rules)</tt></dd></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-fw_policy"><strong>fw_policy</strong></a>(self, log<font color="#909090">='On'</font>, directions<font color="#909090">=None</font>)</dt><dd><tt>Usage:<br>
policies&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPUpdateEFMConfigHandler-fw_policy">fw_policy</a>()<br>
proxy.UpdateEFMConfigHandler(vsys.vsysId,&nbsp;firewall.efmId).<a href="#FGCPUpdateEFMConfigHandler-fw_policy">fw_policy</a>('On',&nbsp;policies)<br>
&nbsp;<br>
Warning:&nbsp;this&nbsp;overrides&nbsp;the&nbsp;complete&nbsp;firewall&nbsp;configuration,&nbsp;so&nbsp;you&nbsp;need&nbsp;to&nbsp;specify&nbsp;all&nbsp;the&nbsp;policies&nbsp;at&nbsp;once&nbsp;!</tt></dd></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_cca_add"><strong>slb_cca_add</strong></a>(self, ccacertNum, filePath)</dt><dd><tt>Note:&nbsp;cca&nbsp;certificates&nbsp;in&nbsp;.crt&nbsp;or&nbsp;.pem&nbsp;format&nbsp;ARE&nbsp;supported&nbsp;here&nbsp;(and&nbsp;others&nbsp;?)</tt></dd></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_cca_delete"><strong>slb_cca_delete</strong></a>(self, ccacertNum)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_cert_add"><strong>slb_cert_add</strong></a>(self, certNum, filePath, passphrase)</dt><dd><tt>Note:&nbsp;server&nbsp;certificates&nbsp;in&nbsp;unencrypted&nbsp;PEM&nbsp;format&nbsp;are&nbsp;NOT&nbsp;supported&nbsp;here,&nbsp;use&nbsp;PKCS12&nbsp;format&nbsp;(and&nbsp;others&nbsp;?)</tt></dd></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_cert_delete"><strong>slb_cert_delete</strong></a>(self, certNum, force<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_cert_release"><strong>slb_cert_release</strong></a>(self, certNum)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_cert_set"><strong>slb_cert_set</strong></a>(self, certNum, id)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_error_clear"><strong>slb_error_clear</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_load_clear"><strong>slb_load_clear</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_rule"><strong>slb_rule</strong></a>(self, groups<font color="#909090">=None</font>, force<font color="#909090">=None</font>, webAccelerator<font color="#909090">=None</font>)</dt><dd><tt>Usage:<br>
slb_rule&nbsp;=&nbsp;proxy.GetEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPUpdateEFMConfigHandler-slb_rule">slb_rule</a>()<br>
proxy.UpdateEFMConfigHandler(vsys.vsysId,&nbsp;loadbalancer.efmId).<a href="#FGCPUpdateEFMConfigHandler-slb_rule">slb_rule</a>(slb_rule.groups)<br>
&nbsp;<br>
Warning:&nbsp;this&nbsp;overrides&nbsp;the&nbsp;complete&nbsp;loadbalancer&nbsp;configuration,&nbsp;so&nbsp;you&nbsp;need&nbsp;to&nbsp;specify&nbsp;all&nbsp;the&nbsp;groups&nbsp;at&nbsp;once&nbsp;!</tt></dd></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_start_maint"><strong>slb_start_maint</strong></a>(self, id, ipAddress, time<font color="#909090">=None</font>, unit<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_stop_maint"><strong>slb_stop_maint</strong></a>(self, id, ipAddress)</dt></dl>

<dl><dt><a name="FGCPUpdateEFMConfigHandler-slb_try_updateaction"><strong>slb_try_updateaction</strong></a>(self, action)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>:<br>
<dl><dt><a name="FGCPUpdateEFMConfigHandler-__init__"><strong>__init__</strong></a>(self, proxy, vsysId<font color="#909090">=None</font>, efmId<font color="#909090">=None</font>)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.command.html#FGCPGenericEFMHandler">FGCPGenericEFMHandler</a>:<br>
<dl><dt><strong>efmId</strong> = None</dl>

<dl><dt><strong>vsysId</strong> = None</dl>

</td></tr></table></td></tr></table>
</body></html>